<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>QSculpt: Iterator&lt; T &gt; Class Template Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">QSculpt
   &#160;<span id="projectnumber">0.0.1a</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Iterator&lt; T &gt; Class Template Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Iterator" -->
<p><code>#include &lt;<a class="el" href="_i_iterator_8h_source.html">IIterator.h</a>&gt;</code></p>

<p><a href="class_iterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a40599bebf780bd35fcb885d5475bcf4e">Iterator</a> (<a class="el" href="class_i_iterator.html">IIterator</a>&lt; T &gt; *it=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#ab2e87dd1cbc330edb7709dfc1e07da02">Iterator</a> (const <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt; &amp;cpy)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#ae3ca5d592c9550743e6bfe07e5881c13">~Iterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_iterator.html">Iterator</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a1553004116ce9a9daf090da9a7d3edd0">operator=</a> (const <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt; &amp;it)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a146904d78b57b793a9fc2a5e4a5857d1">hasNext</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#ae3b318b740496814a7b9d99f1dd04022">hasPrevious</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#ad27bc945f5c433bf84b45fee9c11a8dd">next</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a69e4090a84a85c4ffc2811924d042c1c">next</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a02f2498a4f39c21d6444c7f297953ee8">peekNext</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a68920d39a28e82cfbd143bb2a4bd4ea6">peekNext</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#aa57773d32b7a91f896610922454aedfa">previous</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a037a5a6cbf34be39e6bcec029809b159">previous</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_iterator.html#a42b51cf85536d37b0e172d62a356fb15">seek</a> (int pos, IteratorOrigin origin=Iter_Start) const </td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br/>
class Iterator&lt; T &gt;</h3>

<p>Wrapper class around classes derived from <a class="el" href="class_i_iterator.html">IIterator</a>.</p>
<p>Offers copy / clone semantics between iterators. It is a small class and is meant to be be used as a variables stored in the stack. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a40599bebf780bd35fcb885d5475bcf4e"></a><!-- doxytag: member="Iterator::Iterator" ref="a40599bebf780bd35fcb885d5475bcf4e" args="(IIterator&lt; T &gt; *it=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::<a class="el" href="class_iterator.html">Iterator</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_i_iterator.html">IIterator</a>&lt; T &gt; *&#160;</td>
          <td class="paramname"><em>it</em> = <code>0</code></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p><a class="el" href="class_iterator.html">Iterator</a> constructor. Sets up this iterator wrapper around the passed iterator implementation class. </p>

</div>
</div>
<a class="anchor" id="ab2e87dd1cbc330edb7709dfc1e07da02"></a><!-- doxytag: member="Iterator::Iterator" ref="ab2e87dd1cbc330edb7709dfc1e07da02" args="(const Iterator&lt; T &gt; &amp;cpy)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::<a class="el" href="class_iterator.html">Iterator</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt; &amp;&#160;</td>
          <td class="paramname"><em>cpy</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Contructor to make a copy of another iterator. </p>

</div>
</div>
<a class="anchor" id="ae3ca5d592c9550743e6bfe07e5881c13"></a><!-- doxytag: member="Iterator::~Iterator" ref="ae3ca5d592c9550743e6bfe07e5881c13" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::~<a class="el" href="class_iterator.html">Iterator</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Deletes the iterator implementation instance. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a146904d78b57b793a9fc2a5e4a5857d1"></a><!-- doxytag: member="Iterator::hasNext" ref="a146904d78b57b793a9fc2a5e4a5857d1" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::hasNext </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return true if the iterator has more elements (i.e. it is not at the end) </p>

</div>
</div>
<a class="anchor" id="ae3b318b740496814a7b9d99f1dd04022"></a><!-- doxytag: member="Iterator::hasPrevious" ref="ae3b318b740496814a7b9d99f1dd04022" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::hasPrevious </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns true if the iterator is not at the beginning of the iteration </p>

</div>
</div>
<a class="anchor" id="ad27bc945f5c433bf84b45fee9c11a8dd"></a><!-- doxytag: member="Iterator::next" ref="ad27bc945f5c433bf84b45fee9c11a8dd" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::next </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the next element and advance the iterator by one. </p>

</div>
</div>
<a class="anchor" id="a69e4090a84a85c4ffc2811924d042c1c"></a><!-- doxytag: member="Iterator::next" ref="a69e4090a84a85c4ffc2811924d042c1c" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::next </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the next element and advance the iterator by one. </p>

</div>
</div>
<a class="anchor" id="a1553004116ce9a9daf090da9a7d3edd0"></a><!-- doxytag: member="Iterator::operator=" ref="a1553004116ce9a9daf090da9a7d3edd0" args="(const Iterator&lt; T &gt; &amp;it)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_iterator.html">Iterator</a>&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt; &amp;&#160;</td>
          <td class="paramname"><em>it</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Assignment operator. </p>

</div>
</div>
<a class="anchor" id="a02f2498a4f39c21d6444c7f297953ee8"></a><!-- doxytag: member="Iterator::peekNext" ref="a02f2498a4f39c21d6444c7f297953ee8" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::peekNext </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the next element without advancing to the iterator </p>

</div>
</div>
<a class="anchor" id="a68920d39a28e82cfbd143bb2a4bd4ea6"></a><!-- doxytag: member="Iterator::peekNext" ref="a68920d39a28e82cfbd143bb2a4bd4ea6" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::peekNext </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Return the next element without advancing to the iterator </p>

</div>
</div>
<a class="anchor" id="aa57773d32b7a91f896610922454aedfa"></a><!-- doxytag: member="Iterator::previous" ref="aa57773d32b7a91f896610922454aedfa" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">T&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::previous </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the previous elements and move the iterator one position backwards. </p>

</div>
</div>
<a class="anchor" id="a037a5a6cbf34be39e6bcec029809b159"></a><!-- doxytag: member="Iterator::previous" ref="a037a5a6cbf34be39e6bcec029809b159" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T&amp; <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::previous </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the previous elements and move the iterator one position backwards. </p>

</div>
</div>
<a class="anchor" id="a42b51cf85536d37b0e172d62a356fb15"></a><!-- doxytag: member="Iterator::seek" ref="a42b51cf85536d37b0e172d62a356fb15" args="(int pos, IteratorOrigin origin=Iter_Start) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="class_iterator.html">Iterator</a>&lt; T &gt;::seek </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>pos</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">IteratorOrigin&#160;</td>
          <td class="paramname"><em>origin</em> = <code>Iter_Start</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Set the current position to pos relative to origin.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pos</td><td>number of elements to jump relative to origin </td></tr>
    <tr><td class="paramname">origin</td><td>states the reference to jump. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>engine/include/<a class="el" href="_i_iterator_8h_source.html">IIterator.h</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Sat Aug 27 2011 15:38:53 for QSculpt by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
